feat: automated Release Announcement draft maintained by GitHub Copilot#3642
Closed
pljones wants to merge 25 commits intojamulussoftware:mainfrom
Closed
feat: automated Release Announcement draft maintained by GitHub Copilot#3642pljones wants to merge 25 commits intojamulussoftware:mainfrom
pljones wants to merge 25 commits intojamulussoftware:mainfrom
Conversation
5 tasks
3df15d5 to
6a0e44f
Compare
Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
… failure Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
…le only) Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
…I responses Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
…29 detection to backfill script Co-authored-by: pljones <1549463+pljones@users.noreply.github.com>
e47739f to
f356a6b
Compare
e32578e to
9b9032f
Compare
34a857b to
a5c4f1c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short description of changes
Adds
ReleaseAnnouncement.md— a working draft of the end-user release announcement (separate fromChangeLog) that GitHub Copilot keeps up to date automatically, matching the conversational bullet-point style used in real Jamulus Discussion posts.New files
ReleaseAnnouncement.md— live draft; flat bullet list; includes Windows virus-checker REMINDER and pointer totools/get_release_contributors.py.github/release-announcement-template.md— pristine blank template; copied over the draft after each full release.github/prompts/release-announcement.prompt.yml— AI prompt with verbatim real Jamulus announcement examples;modelParameters.maxCompletionTokens: 16384/temperature: 0.1(action default of 200 tokens would truncate mid-document)Workflow:
.github/workflows/update-release-announcement.ymlpull_request_target: closed → main— updates draft on every merged PR; workflow + prompt always sourced frommain; PR body written to$RUNNER_TEMPviaenv:before passing asfile_input(prevents YAML injection);CHANGELOG: SKIPin PR body skips updatepush: branches: autobuild**— updates draft on the autobuild branch itself so developers can preview how their change would read in the announcement before merging; loop prevention viagithub.actor != 'github-actions[bot]';autobuild.ymlalready hasReleaseAnnouncement.mdinpaths-ignorepush: tags: r*+reset-after-releasejob — resets to template only on clean version tags (r3_12_0); pre-release tags (r3_12_0beta1,r3_12_0rc1) intentionally leave the draft intact so it accumulates through the beta/RC cycleautobuild.yml—ReleaseAnnouncement.md,.github/release-announcement-template.md,.github/prompts/**added topaths-ignoreso bot commits don't trigger builds.CONTRIBUTING.md/.github/pull_request_template.md— note thatCHANGELOG:feeds bothChangeLogandReleaseAnnouncement.md;CHANGELOG: SKIPskips both.CHANGELOG: SKIP
Context: Fixes an issue?
Implements the approach discussed in #3443 (comment) and https://github.com/orgs/jamulussoftware/discussions/3626.
Does this change need documentation? What needs to be documented and how?
The release process checklist at https://jamulus.io/contribute/Release-Process could reference
ReleaseAnnouncement.mdas the draft to polish and publish, replacing the manual "Draft an announcement" step at the RC stage.Status of this Pull Request
Working implementation. Requires GitHub Models (
models: readpermission) to be enabled on the repository foractions/ai-inference@v1.What is missing until this pull request can be merged?
Confirm GitHub Models access is available for this repo.
Checklist